Writing for the HTML Help System

If you wish to make a contribution to the HTML Help System, please make contact on the FreeDOS mailing list:

   fd-dev@topica.com

or contact the maintainer at:

   worldwiderob@yahoo.co.uk

The structure of the \help directory

\help\index.htm
  HELP will load this by default. 
  (The HTML Help System includes the standard index.htm,
   but a special distribution might replace this.)

\help\hhstndrd
  Reserved for the standard html set - the one that comes with
  the standard HTML Help System as found on the FreeDOS website.
  (A special distribution or a package with its own set of html files
   should use something else.)

\help\[name].htm
  HELP will attempt a load of this if "HELP name [subtopic]"
  is typed at the command prompt (unless it finds an exact match
  to a topic in index.htm. File loads can be forced using the /L
  command line parameter.)

Creating modified versions of the help files

Use a distinct title on the title page (often index.htm) in any modified versions. This is to avoid any confusion or conflicts, and most importantly, is necessary under the GNU Free Documentation License part 4A. In addition to changing the title, please update the history, list of authors etc, in accordance with section 4 of the GNU Free Documentation License.

If the file set is meant to describe a new or modified package, or if the file set undergoes a fundamental change (e.g. a translation), then it is best to use a distinct subdirectory name, as expained in "The structure of the \help directory" above. This is simply a matter of doing a find and replace on the subdirectory name in index.htm, and is well worth it.

For example, a streamlined version of the "hhstndrd" file set might be called "hhmicro". This would be the name of the subdirectory, and the title in index.htm might be:

   FreeDOS Help (hhmicro 1.0)

It is reasonable to change only the version number (rather than the name and directory "hhmicro") when releasing updates.

Creating or adding new files

It is advised that the following license message be put at the end of any new help files (unless it is going to be a stand alone file, not included in a help file set):

   ...
   <hr>
   <address>
   <b>Copyright &copy; 2003
   <a href="mailto:myemail@address.com">My Name</a></b><br>
   This file forms part of The FreeDOS HTML Help Documentation, and is
   covered under its terms, see
   <a href="../index.htm">index.htm</a>
   </address>
   </body>
   </html>

Providing an email is optional, but preferable. The terms are the GNU Free Documentation License.

Testing Help Files

The reference browsers for testing help files are:

the FreeDOS HTML Help Viewer (help.exe)
Netscape Navigator.

Creating Tables

Unfortunately, help does not support table tags. Use the preformatting tags <pre> </pre> for tables of information.

General Tips

Press F5 or Ctrl+R to refresh the file being displayed by Help. The effects of changes to the file can be seen immediately. Useful when editing help files in a windows-type environment.

To use HTML Help Viewer to view files that aren't yet integrated into the file set, the help path override switch can be used:

    help /O[drive:][path]filename[.htm]

or if relative to the /HELP folder:

    help /L[subdirs]filename[.htm]